<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PxShapeExt Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="PhysXLogoBlack.png"/></td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classPxShapeExt.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classPxShapeExt-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">PxShapeExt Class Reference<div class="ingroups"><a class="el" href="group__extensions.html">Extensions</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>utility functions for use with <a class="el" href="classPxShape.html" title="Abstract class for collision shapes. ">PxShape</a>  
 <a href="classPxShapeExt.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="PxShapeExt_8h_source.html">PxShapeExt.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:adf481eb1ae61121027ae6bbf5829f497"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> <a class="el" href="classPxTransform.html">PxTransform</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxShapeExt.html#adf481eb1ae61121027ae6bbf5829f497">getGlobalPose</a> (const <a class="el" href="classPxShape.html">PxShape</a> &amp;shape, const <a class="el" href="classPxRigidActor.html">PxRigidActor</a> &amp;actor)</td></tr>
<tr class="memdesc:adf481eb1ae61121027ae6bbf5829f497"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the world space pose of the shape.  <a href="#adf481eb1ae61121027ae6bbf5829f497">More...</a><br /></td></tr>
<tr class="separator:adf481eb1ae61121027ae6bbf5829f497"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa96a6b923cccd8bf680d4bf9fb8aee2d"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> <a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxShapeExt.html#aa96a6b923cccd8bf680d4bf9fb8aee2d">raycast</a> (const <a class="el" href="classPxShape.html">PxShape</a> &amp;shape, const <a class="el" href="classPxRigidActor.html">PxRigidActor</a> &amp;actor, const <a class="el" href="classPxVec3.html">PxVec3</a> &amp;rayOrigin, const <a class="el" href="classPxVec3.html">PxVec3</a> &amp;rayDir, PxReal maxDist, PxHitFlags hitFlags, <a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> maxHits, <a class="el" href="structPxRaycastHit.html">PxRaycastHit</a> *rayHits)</td></tr>
<tr class="memdesc:aa96a6b923cccd8bf680d4bf9fb8aee2d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Raycast test against the shape.  <a href="#aa96a6b923cccd8bf680d4bf9fb8aee2d">More...</a><br /></td></tr>
<tr class="separator:aa96a6b923cccd8bf680d4bf9fb8aee2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:affe9828effe773b79ab836691b72d62a"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxShapeExt.html#affe9828effe773b79ab836691b72d62a">overlap</a> (const <a class="el" href="classPxShape.html">PxShape</a> &amp;shape, const <a class="el" href="classPxRigidActor.html">PxRigidActor</a> &amp;actor, const <a class="el" href="classPxGeometry.html">PxGeometry</a> &amp;otherGeom, const <a class="el" href="classPxTransform.html">PxTransform</a> &amp;otherGeomPose)</td></tr>
<tr class="memdesc:affe9828effe773b79ab836691b72d62a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test overlap between the shape and a geometry object.  <a href="#affe9828effe773b79ab836691b72d62a">More...</a><br /></td></tr>
<tr class="separator:affe9828effe773b79ab836691b72d62a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9fb19195f3ac80b6ab55fd0aa7a41cf3"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxShapeExt.html#a9fb19195f3ac80b6ab55fd0aa7a41cf3">sweep</a> (const <a class="el" href="classPxShape.html">PxShape</a> &amp;shape, const <a class="el" href="classPxRigidActor.html">PxRigidActor</a> &amp;actor, const <a class="el" href="classPxVec3.html">PxVec3</a> &amp;unitDir, const PxReal distance, const <a class="el" href="classPxGeometry.html">PxGeometry</a> &amp;otherGeom, const <a class="el" href="classPxTransform.html">PxTransform</a> &amp;otherGeomPose, <a class="el" href="structPxSweepHit.html">PxSweepHit</a> &amp;sweepHit, PxHitFlags hitFlags)</td></tr>
<tr class="memdesc:a9fb19195f3ac80b6ab55fd0aa7a41cf3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sweep a geometry object against the shape.  <a href="#a9fb19195f3ac80b6ab55fd0aa7a41cf3">More...</a><br /></td></tr>
<tr class="separator:a9fb19195f3ac80b6ab55fd0aa7a41cf3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a71b7808c2c0623fe264f7973be837897"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> <a class="el" href="classPxBounds3.html">PxBounds3</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxShapeExt.html#a71b7808c2c0623fe264f7973be837897">getWorldBounds</a> (const <a class="el" href="classPxShape.html">PxShape</a> &amp;shape, const <a class="el" href="classPxRigidActor.html">PxRigidActor</a> &amp;actor, float inflation=1.01f)</td></tr>
<tr class="memdesc:a71b7808c2c0623fe264f7973be837897"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the axis aligned bounding box enclosing the shape.  <a href="#a71b7808c2c0623fe264f7973be837897">More...</a><br /></td></tr>
<tr class="separator:a71b7808c2c0623fe264f7973be837897"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>utility functions for use with <a class="el" href="classPxShape.html" title="Abstract class for collision shapes. ">PxShape</a> </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxShape.html" title="Abstract class for collision shapes. ">PxShape</a> </dd></dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="adf481eb1ae61121027ae6bbf5829f497"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adf481eb1ae61121027ae6bbf5829f497">&#9670;&nbsp;</a></span>getGlobalPose()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> <a class="el" href="classPxTransform.html">PxTransform</a> PxShapeExt::getGlobalPose </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classPxShape.html">PxShape</a> &amp;&#160;</td>
          <td class="paramname"><em>shape</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classPxRigidActor.html">PxRigidActor</a> &amp;&#160;</td>
          <td class="paramname"><em>actor</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Retrieves the world space pose of the shape. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">shape</td><td>The shape for which to get the global pose. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">actor</td><td>The actor to which the shape is attached</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Global pose of shape. </dd></dl>

<p class="reference">References <a class="el" href="classPxRigidActor.html#a6eb5e3d590e6087c930f8141d40de722">PxRigidActor::getGlobalPose()</a>, and <a class="el" href="classPxShape.html#af455638230d515adbfb561f1064e70a1">PxShape::getLocalPose()</a>.</p>

</div>
</div>
<a id="a71b7808c2c0623fe264f7973be837897"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a71b7808c2c0623fe264f7973be837897">&#9670;&nbsp;</a></span>getWorldBounds()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> <a class="el" href="classPxBounds3.html">PxBounds3</a> PxShapeExt::getWorldBounds </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classPxShape.html">PxShape</a> &amp;&#160;</td>
          <td class="paramname"><em>shape</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classPxRigidActor.html">PxRigidActor</a> &amp;&#160;</td>
          <td class="paramname"><em>actor</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>inflation</em> = <code>1.01f</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Retrieves the axis aligned bounding box enclosing the shape. </p>
<dl class="section return"><dt>Returns</dt><dd>The shape's bounding box.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">shape</td><td>the shape </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">actor</td><td>the actor to which the shape is attached </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">inflation</td><td>Scale factor for computed world bounds. Box extents are multiplied by this value.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxBounds3.html" title="Class representing 3D range or axis aligned bounding box. ">PxBounds3</a> </dd></dl>

<p class="reference">References <a class="el" href="classPxGeometryHolder.html#a6c9aeca0bda5885f935c8aaae56851bd">PxGeometryHolder::any()</a>, <a class="el" href="classPxShape.html#a531b866a02c9dc59131bc9887c065ff8">PxShape::getGeometry()</a>, and <a class="el" href="classPxGeometryQuery.html#aac80fbc6fd9c2315aee6dddc9c1e9795">PxGeometryQuery::getWorldBounds()</a>.</p>

</div>
</div>
<a id="affe9828effe773b79ab836691b72d62a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#affe9828effe773b79ab836691b72d62a">&#9670;&nbsp;</a></span>overlap()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> bool PxShapeExt::overlap </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classPxShape.html">PxShape</a> &amp;&#160;</td>
          <td class="paramname"><em>shape</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classPxRigidActor.html">PxRigidActor</a> &amp;&#160;</td>
          <td class="paramname"><em>actor</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classPxGeometry.html">PxGeometry</a> &amp;&#160;</td>
          <td class="paramname"><em>otherGeom</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classPxTransform.html">PxTransform</a> &amp;&#160;</td>
          <td class="paramname"><em>otherGeomPose</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Test overlap between the shape and a geometry object. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">shape</td><td>the shape </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">actor</td><td>the actor to which the shape is attached </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">otherGeom</td><td>The other geometry object to test overlap with </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">otherGeomPose</td><td>Pose of the other geometry object </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the shape overlaps the geometry object</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxGeometry.html" title="A geometry object. ">PxGeometry</a> <a class="el" href="classPxTransform.html" title="class representing a rigid euclidean transform as a quaternion and a vector ">PxTransform</a> </dd></dl>

<p class="reference">References <a class="el" href="classPxGeometryHolder.html#a6c9aeca0bda5885f935c8aaae56851bd">PxGeometryHolder::any()</a>, <a class="el" href="classPxShape.html#a531b866a02c9dc59131bc9887c065ff8">PxShape::getGeometry()</a>, and <a class="el" href="classPxGeometryQuery.html#a62d7a791dba43d475d96a28571f585b4">PxGeometryQuery::overlap()</a>.</p>

</div>
</div>
<a id="aa96a6b923cccd8bf680d4bf9fb8aee2d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa96a6b923cccd8bf680d4bf9fb8aee2d">&#9670;&nbsp;</a></span>raycast()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> <a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> PxShapeExt::raycast </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classPxShape.html">PxShape</a> &amp;&#160;</td>
          <td class="paramname"><em>shape</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classPxRigidActor.html">PxRigidActor</a> &amp;&#160;</td>
          <td class="paramname"><em>actor</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> &amp;&#160;</td>
          <td class="paramname"><em>rayOrigin</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> &amp;&#160;</td>
          <td class="paramname"><em>rayDir</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">PxReal&#160;</td>
          <td class="paramname"><em>maxDist</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">PxHitFlags&#160;</td>
          <td class="paramname"><em>hitFlags</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a>&#160;</td>
          <td class="paramname"><em>maxHits</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structPxRaycastHit.html">PxRaycastHit</a> *&#160;</td>
          <td class="paramname"><em>rayHits</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Raycast test against the shape. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">shape</td><td>the shape </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">actor</td><td>the actor to which the shape is attached </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">rayOrigin</td><td>The origin of the ray to test the geometry object against </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">rayDir</td><td>The direction of the ray to test the geometry object against </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">maxDist</td><td>Maximum ray length </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">hitFlags</td><td>Specify which properties per hit should be computed and written to result hit array. Combination of <a class="el" href="structPxHitFlag.html" title="Scene query and geometry query behavior flags. ">PxHitFlag</a> flags </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">maxHits</td><td>max number of returned hits = size of 'rayHits' buffer </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">rayHits</td><td>Raycast hits information </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of hits between the ray and the shape</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structPxRaycastHit.html" title="Stores results of raycast queries. ">PxRaycastHit</a> <a class="el" href="classPxTransform.html" title="class representing a rigid euclidean transform as a quaternion and a vector ">PxTransform</a> </dd></dl>

<p class="reference">References <a class="el" href="classPxGeometryHolder.html#a6c9aeca0bda5885f935c8aaae56851bd">PxGeometryHolder::any()</a>, <a class="el" href="classPxShape.html#a531b866a02c9dc59131bc9887c065ff8">PxShape::getGeometry()</a>, and <a class="el" href="classPxGeometryQuery.html#a79e90c0d753b17536aa1b8d1f2f29baa">PxGeometryQuery::raycast()</a>.</p>

</div>
</div>
<a id="a9fb19195f3ac80b6ab55fd0aa7a41cf3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9fb19195f3ac80b6ab55fd0aa7a41cf3">&#9670;&nbsp;</a></span>sweep()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> bool PxShapeExt::sweep </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classPxShape.html">PxShape</a> &amp;&#160;</td>
          <td class="paramname"><em>shape</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classPxRigidActor.html">PxRigidActor</a> &amp;&#160;</td>
          <td class="paramname"><em>actor</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> &amp;&#160;</td>
          <td class="paramname"><em>unitDir</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const PxReal&#160;</td>
          <td class="paramname"><em>distance</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classPxGeometry.html">PxGeometry</a> &amp;&#160;</td>
          <td class="paramname"><em>otherGeom</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classPxTransform.html">PxTransform</a> &amp;&#160;</td>
          <td class="paramname"><em>otherGeomPose</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structPxSweepHit.html">PxSweepHit</a> &amp;&#160;</td>
          <td class="paramname"><em>sweepHit</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">PxHitFlags&#160;</td>
          <td class="paramname"><em>hitFlags</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Sweep a geometry object against the shape. </p>
<p>Currently only box, sphere, capsule and convex mesh shapes are supported, i.e. the swept geometry object must be one of those types.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">shape</td><td>the shape </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">actor</td><td>the actor to which the shape is attached </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">unitDir</td><td>Normalized direction along which the geometry object should be swept. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">distance</td><td>Sweep distance. Needs to be larger than 0. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">otherGeom</td><td>The geometry object to sweep against the shape </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">otherGeomPose</td><td>Pose of the geometry object </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">sweepHit</td><td>The sweep hit information. Only valid if this method returns true. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">hitFlags</td><td>Specify which properties per hit should be computed and written to result hit array. Combination of <a class="el" href="structPxHitFlag.html" title="Scene query and geometry query behavior flags. ">PxHitFlag</a> flags </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the swept geometry object hits the shape</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxGeometry.html" title="A geometry object. ">PxGeometry</a> <a class="el" href="classPxTransform.html" title="class representing a rigid euclidean transform as a quaternion and a vector ">PxTransform</a> <a class="el" href="structPxSweepHit.html" title="Stores results of sweep queries. ">PxSweepHit</a> </dd></dl>

<p class="reference">References <a class="el" href="classPxGeometryHolder.html#a6c9aeca0bda5885f935c8aaae56851bd">PxGeometryHolder::any()</a>, <a class="el" href="classPxShape.html#a531b866a02c9dc59131bc9887c065ff8">PxShape::getGeometry()</a>, and <a class="el" href="classPxGeometryQuery.html#a574970e722f882778a250c51f77b5b85">PxGeometryQuery::sweep()</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxShapeExt_8h_source.html">PxShapeExt.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="classPxShapeExt.html">PxShapeExt</a></li>
    <li class="footer">Copyright &copy; 2008-2021 NVIDIA Corporation, 2788 San Tomas Expressway, Santa Clara, CA 95051 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a></li>
  </ul>
</div>
</body>
</html>
